Get all entities

GET

/entities

Retrieve a list of all entities.

Headers

Auth

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

x-monite-versionstringRequired

Query parameters

order"asc" or "desc"Optional

Order by

Allowed values: ascdesc

limitintegerOptional

Max is 100

pagination_tokenstringOptional

A token, obtained from previous page. Prior over other filters

sort"created_at" or "updated_at"Optional

Allowed sort fields

Allowed values: created_atupdated_at

type"individual" or "organization"Optional

Allowed values: individualorganization

created_at__gtdatetimeOptional

created_at__ltdatetimeOptional

created_at__gtedatetimeOptional

created_at__ltedatetimeOptional

id__instringOptional

id__not_instringOptional

emailstringOptional

email__instringOptional

email__not_instringOptional

Response

This endpoint returns an object.

datalist of objects

A set of entities of different types returned per page

next_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the next page of results, or null if there is no next page (i.e. you’ve reached the last page).

prev_pagination_tokenstringOptional

A token that can be sent in the pagination_token query parameter to get the previous page of results, or null if there is no previous page (i.e. you’ve reached the first page).

Errors

GET

1 curl https://api.sandbox.monite.com/v1/entities \
2      -H "x-monite-version: 2024-01-31" \
3      -H "Authorization: Bearer <token>"

1 {
2   "data": [
3     {
4       "type": "individual",
5       "address": {
6         "city": "city",
7         "country": "AF",
8         "line1": "line1",
9         "postal_code": "postal_code"
10       },
11       "created_at": "2024-01-15T09:30:00Z",
12       "id": "data",
13       "individual": {
14         "first_name": "first_name",
15         "last_name": "last_name"
16       },
17       "status": "active",
18       "updated_at": "2024-01-15T09:30:00Z",
19       "email": "data",
20       "logo": {
21         "id": "id",
22         "created_at": "2024-01-15T09:30:00Z",
23         "file_type": "payables",
24         "md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
25         "mimetype": "application/pdf",
26         "name": "invoice.pdf",
27         "region": "eu-central-1",
28         "size": 24381,
29         "url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
30         "pages": [
31           {
32             "id": "id",
33             "mimetype": "image/png",
34             "number": 0,
35             "size": 21972,
36             "url": "https://bucket.s3.amazonaws.com/123/456.png"
37           }
38         ],
39         "previews": [
40           {
41             "height": 400,
42             "url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
43             "width": 200
44           }
45         ]
46       },
47       "phone": "data",
48       "tax_id": "data",
49       "website": "data"
50     }
51   ],
52   "next_pagination_token": "next_pagination_token",
53   "prev_pagination_token": "prev_pagination_token"
54 }

Create an entity

Up Next

1	curl https://api.sandbox.monite.com/v1/entities \
2	-H "x-monite-version: 2024-01-31" \
3	-H "Authorization: Bearer <token>"

1	{
2	"data": [
3	{
4	"type": "individual",
5	"address": {
6	"city": "city",
7	"country": "AF",
8	"line1": "line1",
9	"postal_code": "postal_code"
10	},
11	"created_at": "2024-01-15T09:30:00Z",
12	"id": "data",
13	"individual": {
14	"first_name": "first_name",
15	"last_name": "last_name"
16	},
17	"status": "active",
18	"updated_at": "2024-01-15T09:30:00Z",
19	"email": "data",
20	"logo": {
21	"id": "id",
22	"created_at": "2024-01-15T09:30:00Z",
23	"file_type": "payables",
24	"md5": "31d1a2dd1ad3dfc39be849d70a68dac0",
25	"mimetype": "application/pdf",
26	"name": "invoice.pdf",
27	"region": "eu-central-1",
28	"size": 24381,
29	"url": "https://bucketname.s3.amazonaws.com/12345/67890.pdf",
30	"pages": [
31	{
32	"id": "id",
33	"mimetype": "image/png",
34	"number": 0,
35	"size": 21972,
36	"url": "https://bucket.s3.amazonaws.com/123/456.png"
37	}
38	],
39	"previews": [
40	{
41	"height": 400,
42	"url": "https://bucketname.s3.amazonaws.com/1/2/3.png",
43	"width": 200
44	}
45	]
46	},
47	"phone": "data",
48	"tax_id": "data",
49	"website": "data"
50	}
51	],
52	"next_pagination_token": "next_pagination_token",
53	"prev_pagination_token": "prev_pagination_token"
54	}