Company agreement list

get

https://billing.twin24.ai/api/v1/agreements

Use this endpoint to get list of company agreements.

Query Params

withoutCount

boolean

Defaults to false

Determines whether to return the total number of records.

withoutItems

boolean

Defaults to false

Determines whether to return the record list.

limit

integer

Defaults to 10

Maxium number of returning records.

offset

integer

Starting point to return records from a result set.

page

integer

Page number, used to paginate over all records.

fields

string

Comma-separated list of a record's fields to be fetched

sort

string

Comma-separated list of fields to sort by. Each sort field can have special prefix indicating a desirable sort order: + (ascending order, default) or - (descending order). The available sort fields: companyId, name, number, signedAt and isDefault

companyId

integer

The company identifier to filter by.

keyword

string

Any text to search by agreement name or agreement number.

from

string

The start date (for example, 2018-05-27T21:30:54+00:00).

string

The end date (for example, 2018-05-27T21:30:54+00:00).

default

boolean

To select only default or not default agreements.

Responses

400

Invalid input parameters

401

User is not authenticated

403

Invalid user permissions

Language

Credentials

Bearer

JWT

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

5XXUnexpected error