Skip to main content
GET
List suppliers
Only organization admins can list suppliers. Narrow the list with name, document and status, sort it with orderBy and order, and page through it with limit (25 by default) and next: each page answers the cursor of the following one as next, which is null on the last page. name matches the suppliers whose name or trade name contains the text, ignoring case, and document those whose document contains the characters. status is an exact match.

Path Parameters

realmId
string<uuid>
required

ID of your realm.

Format: UUID

organizationId
string<uuid>
required

ID of the organization whose suppliers you want to list.

Format: UUID

Query Parameters

name
string

Only suppliers whose name or trade name contains this text (case-insensitive).

Required string length: 1 - 50
document
string

Only suppliers whose document contains these letters and digits (case-insensitive). Send it with no dots, slashes or hyphens.

Pattern: ^[A-Za-z0-9]+$
status
enum<string>

Only suppliers in this status.

Available options:
ACTIVE,
DEACTIVATED
limit
integer
default:25

Page size. Defaults to 25.

next
string

Cursor returned as next by the previous page. Omit it for the first page.

order
enum<string>
default:DESC

Sort direction. Defaults to DESC: newest first when sorting by createdAt.

Available options:
ASC,
DESC
orderBy
enum<string>
default:createdAt

Field to sort by. Defaults to createdAt.

Available options:
createdAt,
updatedAt,
name,
tradingName,
document

Response

Successful response

A page of suppliers.

items
object[]
required

Suppliers, in the order you asked for (newest first by default).

next
string | null
required

Cursor for the next page. null on the last page.

Example:

"NjcxMWI0YzBkOGUxYTMwMDEyYjdjOWYy"