(GET) Get partners

Retrieve partners by ID. Supports pagination and sorting.

Endpoint

GET /partners

Retrieve partners by id. Supports pagination with take, skip, and sorting by createdAt.

Endpoint text 
GET /partners

Authentication

Requires authentication with an API key that has the partnersRead scope.

Query Parameters

ParameterTypeRequiredDescription
id (query)string (ULID)NoFilter by specific partner ID. Returns a single partner if found.
take (query)numberNoNumber of results to return (default: 50, min: 1, max: 5,000).
skip (query)numberNoNumber of results to skip for pagination (default: 0, min: 0).
sort (query)stringNoSort order by createdAt: "asc" for oldest first, "desc" for newest first (default: "desc").

Request Limits

The `take` parameter supports values from 1 to 5,000. Requests above 5,000 are rejected.

Examples

Request cURL 
curl -X GET "https://api.hoko.to/partners?take=50&sort=desc" \
  -H "Authorization: Bearer <API_KEY>"
Request JavaScript 
const response = await fetch('https://api.hoko.to/partners?take=50&sort=desc', {
	method: 'GET',
	headers: {
		Authorization: 'Bearer <API_KEY>'
	}
});
const partners = await response.json();
Response json 
[
	{
		"id": "<partner_id>",
		"name": "Partner Name",
		"email": "partner@example.com",
		"phone": "+1234567890",
		"createdAt": "2024-01-01T00:00:00Z",
		"updatedAt": "2024-01-01T00:00:00Z"
	}
]