Referencia
Cuentas
Datos de la cuenta y su configuración.
GET
/api/v2/companiesAuthorization
ApiKeyAuth X-API-Key<token>
In: header
Query Parameters
page?integer
Page number
Range
1 <= valueDefault
1itemsPerPage?integer
Items per page
Range
1 <= value <= 1000Default
30query?string
Search by company name, email or phone (case-insensitive partial match). Numeric values also match by company id.
Length
2 <= length <= 100Response Body
application/json
curl -X GET "https://example.com/api/v2/companies"{ "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf", "createdAt": "2019-08-24T14:15:22Z", "code": 0, "meta": { "totalItems": 0, "itemsPerPage": 0, "currentPage": 0 }, "data": [ { "id": 0, "userId": "string", "tariffId": 0, "name": "string", "email": "string", "phone": "string", "note": "string", "status": 0, "apiKey": "string", "expiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "extra": { "fullAddress": "string", "street": "string", "city": "string", "state": "string", "stateCode": "string", "country": "string", "countryCode": "string", "postalCode": "string", "timezone": "string", "website": "string" } } ]}POST
/api/v2/companiesAuthorization
ApiKeyAuth X-API-Key<token>
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/api/v2/companies" \ -H "Content-Type: application/json" \ -d '{ "tariffId": 0, "tariffPeriod": "trial", "name": "string", "userName": "string", "userSurname": "string", "email": "string", "phone": "string", "password": "string", "country": "string" }'{ "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf", "createdAt": "2019-08-24T14:15:22Z", "code": 0, "data": { "id": 0, "userId": "string", "tariffId": 0, "name": "string", "email": "string", "phone": "string", "note": "string", "status": 0, "apiKey": "string", "expiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "extra": { "fullAddress": "string", "street": "string", "city": "string", "state": "string", "stateCode": "string", "country": "string", "countryCode": "string", "postalCode": "string", "timezone": "string", "website": "string" } }}GET
/api/v2/companies/{id}Authorization
ApiKeyAuth X-API-Key<token>
In: header
Path Parameters
id*string
Response Body
application/json
curl -X GET "https://example.com/api/v2/companies/string"{ "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf", "createdAt": "2019-08-24T14:15:22Z", "code": 0, "data": { "id": 0, "userId": "string", "tariffId": 0, "name": "string", "email": "string", "phone": "string", "note": "string", "status": 0, "apiKey": "string", "expiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "extra": { "fullAddress": "string", "street": "string", "city": "string", "state": "string", "stateCode": "string", "country": "string", "countryCode": "string", "postalCode": "string", "timezone": "string", "website": "string" } }}PATCH
/api/v2/companies/{id}Authorization
ApiKeyAuth X-API-Key<token>
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X PATCH "https://example.com/api/v2/companies/string" \ -H "Content-Type: application/json" \ -d '{}'{ "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf", "createdAt": "2019-08-24T14:15:22Z", "code": 0, "data": { "id": 0, "userId": "string", "tariffId": 0, "name": "string", "email": "string", "phone": "string", "note": "string", "status": 0, "apiKey": "string", "expiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "extra": { "fullAddress": "string", "street": "string", "city": "string", "state": "string", "stateCode": "string", "country": "string", "countryCode": "string", "postalCode": "string", "timezone": "string", "website": "string" } }}DELETE
/api/v2/companies/{id}Authorization
ApiKeyAuth X-API-Key<token>
In: header
Path Parameters
id*string
Response Body
application/json
curl -X DELETE "https://example.com/api/v2/companies/string"{ "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf", "createdAt": "2019-08-24T14:15:22Z", "code": 0, "data": { "id": 0 }}GET
/api/v2/companies/{id}/sso-linkAuthorization
ApiKeyAuth X-API-Key<token>
In: header
Path Parameters
id*string
Response Body
application/json
curl -X GET "https://example.com/api/v2/companies/string/sso-link"{ "responseId": "ed662de2-39c1-4e7d-a6bf-6980511adfaf", "createdAt": "2019-08-24T14:15:22Z", "code": 0, "data": { "link": "string" }}