contracts

List contract categories

Returns a paginated list of contract categories.

GET

/v1/contract-categories

curl --request GET \
  --url 'https://api.beamdynamics.io/v1/contract-categories?page=1&limit=20' \
  --header 'beam-api-key: <api-key>'

{
  "currentPage": 123,
  "hasMore": true,
  "results": [
    {
      "color": "<string>",
      "createdAt": "<string>",
      "description": "<string>",
      "entityType": "company",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "sortOrder": 123,
      "studioId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "<string>"
    }
  ],
  "total": 123,
  "totalPages": 123
}

Authorizations

beam-api-keystringheaderrequired

Query Parameters

pageintegerquerydefault:1

1-based page number.

Required range: 1 <= x

limitintegerquerydefault:20

Page size, 1-100, default 20.

Required range: 1 <= x <= 100

Response

Paginated list of contract categories

currentPagenumberrequired

hasMorebooleanrequired

resultsobject[]required

Show child attributes

totalnumberrequired

totalPagesnumberrequired

Still need help? Ask the team