Sign in
latestOpenAPI 3.0.0Apache 2.02026-08-06199181.1 MB

e0d144609998

Partners

List partners

List all partners

get/partners

Query parameters

company_idinteger

Filter by company id

contact_idinteger

Filter by contact id

isThirdParty'yes' | 'no'

Filter by third party flag

searchstring

Search by company name, contact name, or partner id

filtersobject

Filter partners by supported query rules

sort[asc]'id' | 'company_id' | 'contact_id' | 'isThirdParty' | 'createdOn' | 'modifiedOn'

Sort partners in ascending order

sort[desc]'id' | 'company_id' | 'contact_id' | 'isThirdParty' | 'createdOn' | 'modifiedOn'

Sort partners in descending order

pageinteger

The page number to return

per_pageinteger

Items per page, default 50, max 200

Response

Successful operation

messagestring

Example response

{
  "message": "success.",
  "partners": [
    {
      "id": 12,
      "company_id": 45,
      "isThirdParty": "no",
      "type": "Company",
      "name": "Lexzur LLC",
      "label": "Lexzur LLC"
    }
  ],
  "page_context": {
    "page": 1,
    "per_page": 50,
    "total": 1,
    "count": 1
  }
}