Catalog
Catalog - Partner API's.
Operations
POST
# Fetch partner company details
GET
# Get company profile
This API helps in fetch details of partner companies with the help of uid.
Parameters
organization_id
string
Required
organization id of an organization.
Request body
company_ids
array of integer
Response
200
Validate response. See example below or refer `ValidateResponseSchema` for details
CompaniesSchema
items
array of object (CompanySchema)
Array of CompanySchema
uid
integer
created_on
string
| date-time
modified_on
string
| date-time
verified_on
string
| date-time
verified_by
object (UserSchema)
UserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
modified_by
object (UserSchema)
UserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
created_by
object (UserSchema)
UserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
name
string
company_type
string
business_type
string
details
object (CompanyDetails)
CompanyDetails
socials
array of object (CompanySocialAccounts)
Array of CompanySocialAccounts
name
string
url
string
website_url
string
addresses
array of object (GetAddressSchema)
Array of GetAddressSchema
address1
string
address2
string
address_type
string
city
string
country
string
country_code
string
landmark
string
latitude
number
longitude
number
pincode
string
state
string
market_channels
array of string
notification_emails
array of string
reject_reason
string
stage
string
_custom_json
object
business_country_info
object (BusinessCountryInfo)
BusinessCountryInfo
country_code
string
country
string
currency
object (CountryCurrencyInfo)
CountryCurrencyInfo
code
string
symbol
string
name
string
timezone
string
Examples
Parameters
organization_id:
"62c4503b0b2e9711d99b85aa"
body:
body
Was this section helpful?
POST
Response
Parameters
organization_id
string
Required
organization id of an organization.
q
string
search string used to search company.
stage
string
to filter companies on basis of verified or unverified.
Response
200
Company profile object. See example below or refer `CompanyListSchema` for details
CompanyListSchema
page
object (Page)
Page
item_total
integer
| int32
The total number of items on the page.
next_id
string
The identifier for the next page.
has_previous
boolean
Indicates whether there is a previous page.
has_next
boolean
Indicates whether there is a next page.
current
integer
| int32
The current page number.
type
string
The type of the page, such as 'PageType'.
size
integer
| int32
The number of items per page.
total
integer
| int32
Total number of items.
items
array of object (CompanySchema)
Array of CompanySchema
uid
integer
created_on
string
| date-time
modified_on
string
| date-time
verified_on
string
| date-time
verified_by
object (UserSchema)
UserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
modified_by
object (UserSchema)
UserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
created_by
object (UserSchema)
UserSchema
_id
string
contact
string
uid
string
user_id
string
username
string
name
string
company_type
string
business_type
string
details
object (CompanyDetails)
CompanyDetails
socials
array of object (CompanySocialAccounts)
Array of CompanySocialAccounts
name
string
url
string
website_url
string
addresses
array of object (GetAddressSchema)
Array of GetAddressSchema
address1
string
address2
string
address_type
string
city
string
country
string
country_code
string
landmark
string
latitude
number
longitude
number
pincode
string
state
string
market_channels
array of string
notification_emails
array of string
reject_reason
string
stage
string
_custom_json
object
business_country_info
object (BusinessCountryInfo)
BusinessCountryInfo
country_code
string
country
string
currency
object (CountryCurrencyInfo)
CountryCurrencyInfo
code
string
symbol
string
name
string
timezone
string
Examples
Parameters
organization_id:
"62c4503b0b2e9711d99b85aa"
q:
"Cache Company"
stage:
"complete"
Was this section helpful?
GET
Response