/

Get all partners

get

Gets all partners for the organization

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

namestringOptional

Name of the partner

organizationIdintegerOptional

Organization ID the partner belongs to

partnerTypeIdintegerOptional

Partner type ID

addressGroupIdintegerOptional

Address group ID

activebooleanOptional

Whether the partner is active

sortOrderstring · enumRequired

The order to sort by

Example: ascPossible values:

sortBystringOptional

The field to sort by

Example: createdAt

pageNumbernumberOptional

The page number to filter by

Example: 1

pageSizenumberOptional

The page size to filter by

Example: 10

Responses

200Success

application/json

get

/api/partners/

HTTPcURLJavaScriptPython

GET /api/partners/?sortOrder=asc HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "data": [],
  "totalCount": 100,
  "pageNumber": 1,
  "pageSize": 50
}

Create partner

post

Creates a new partner

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

namestringRequired

Name of the partner

partnerTypeIdintegerRequired

Partner type ID

attributesobjectOptional

Additional attributes for the partner

addressGroupIdnumberOptional

Address group ID

activebooleanOptional

Whether the partner is active

Responses

200Success

application/json

post

/api/partners/

HTTPcURLJavaScriptPython

POST /api/partners/ HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 210

{
  "name": "text",
  "partnerTypeId": 1,
  "attributes": {},
  "addressGroupId": 1,
  "addressGroupInput": {
    "name": "Name",
    "description": "Lab",
    "region": "New York",
    "type": "LAB",
    "active": true,
    "addressGroupMapping": []
  },
  "active": true
}

200Success

{
  "id": 1,
  "organizationId": 1,
  "name": "text",
  "addressGroup": {
    "id": 12,
    "name": "Name",
    "description": "Lab",
    "region": "New York",
    "type": "LAB",
    "organizationId": 1,
    "active": true,
    "addressGroupMapping": [],
    "createdAt": "2023-01-01T00:00:00.000Z",
    "updatedAt": "2023-01-01T00:00:00.000Z",
    "addressMappingCount": 1
  },
  "addressGroupId": 1,
  "partnerTypeId": 1,
  "attributes": {},
  "partnerType": {
    "name": "Test Partner Type Name",
    "description": "Test Partner Type Description",
    "partnerType": "CUSTOM",
    "organizationId": 1,
    "active": true,
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z"
  },
  "active": true,
  "createdAt": "2025-12-15",
  "updatedAt": "2025-12-15"
}