Types

Get all partner types

get

Gets all partner types

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

namestringOptional

Name of the partner type

partnerTypestring · enumRequired

Type of the partner

Possible values:

organizationIdnumberOptional

Organization ID the partner type belongs to

activeanyOptional

Active status of the partner type

Example: true

Responses

200Success

application/json

Responseany

get

/api/partners/types

HTTPcURLJavaScriptPython

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

200Success

No content

Create partner type

post

Creates a new partner type

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

namestringRequired

Name of the partner type

descriptionstringOptional

Description of the partner type

partnerTypestring · enumRequired

Type of the partner

Possible values:

activebooleanOptional

Active status of the partner type

Example: true

Responses

200Success

application/json

post

/api/partners/types

HTTPcURLJavaScriptPython

POST /api/partners/types 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: 70

{
  "name": "text",
  "description": "text",
  "partnerType": "LAB",
  "active": true
}

200Success

{
  "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"
}

Get partner type by id

get

Gets a partner type by id

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/partners/types/{id}

HTTPcURLJavaScriptPython

GET /api/partners/types/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}

Update partner type by id

put

Updates a partner type by id

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Body

application/json

namestringRequired

Name of the partner type

descriptionstringOptional

Description of the partner type

partnerTypestring · enumRequired

Type of the partner

Possible values:

activebooleanOptional

Active status of the partner type

Example: true

Responses

200Success

application/json

put

/api/partners/types/{id}

HTTPcURLJavaScriptPython

PUT /api/partners/types/{id} 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: 70

{
  "name": "text",
  "description": "text",
  "partnerType": "LAB",
  "active": true
}

200Success

{
  "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"
}

Delete partner type by id

delete

Deletes a partner type by id

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idnumberRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

delete

/api/partners/types/{id}

HTTPcURLJavaScriptPython

DELETE /api/partners/types/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "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"
}