Skip to main content
GET
/
partners
Get all partners
curl --request GET \
  --url https://api.example.com/partners
[
  {
    "id": "<string>",
    "name": "<string>",
    "partnerTag": {
      "id": "<string>",
      "code": "<string>",
      "name": "<string>",
      "description": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deleted": true,
      "deletedAt": "2023-11-07T05:31:56Z"
    },
    "email": "<string>",
    "firstName": "<string>",
    "middleName": "<string>",
    "lastName": "<string>",
    "contactNumber": "<string>",
    "streetAddressOne": "<string>",
    "city": "<string>",
    "stateOrRegion": "<string>"
  }
]

Query Parameters

page
number
default:1

Page number (1-based)

limit
number
default:10

Number of items per page

Response

200 - application/json

The partners have been successfully retrieved.

id
string
required

The id of the partner

name
string
required

The name of the partner

partnerTag
object

The tag associated with the partner

email
string

The email of the partner

firstName
string

The first name of the partner

middleName
string

The middle name of the partner

lastName
string

The last name of the partner

contactNumber
string

The contact number of the partner

streetAddressOne
string

The address of the partner

city
string

The city of the partner

stateOrRegion
string

The state of the partner