Skip to main content
GET
/
entities
List all entities
curl --request GET \
  --url https://api.syntage.com/entities \
  --header 'X-API-Key: <api-key>'
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "hydra:Collection",
  "hydra:member": [
    {
      "@id": "/entities/91106968-1abd-4d64-85c1-4e73d96fb997",
      "@type": "Link",
      "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
      "type": "company",
      "taxpayer": {
        "@id": "/taxpayers/PEIC211118IS0",
        "@type": "Taxpayer",
        "id": "PEIC211118IS0",
        "personType": "physical",
        "registrationDate": "2023-12-25",
        "name": "Pedro Infante Cruz"
      },
      "credential": {
        "@id": "/credentials/91106968-1abd-4d64-85c1-4e73d96fb997",
        "@type": "Credential",
        "id": "91106968-1abd-4d64-85c1-4e73d96fb997",
        "type": "ciec",
        "rfc": "PEIC211118IS0",
        "status": "pending",
        "createdAt": "2020-01-01T12:15:00.000Z",
        "updatedAt": "2020-01-01T12:15:00.000Z"
      },
      "tags": [
        {
          "@id": "/entity-tags/91106968-1abd-4d64-85c1-4e73d96fb997",
          "@type": "EntityTag",
          "id": "e0a24894-7fbf-48ae-bfb0-efaae30a6319",
          "name": "Important Taxpayer",
          "createdAt": "2020-01-01T12:15:00.000Z",
          "updatedAt": "2020-01-01T12:15:00.000Z"
        }
      ],
      "createdAt": "2020-01-01T12:15:00.000Z",
      "updatedAt": "2020-01-01T12:15:00.000Z"
    }
  ],
  "hydra:view": {
    "@id": "<string>",
    "@type": "hydra:PartialCollectionView",
    "hydra:next": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[lt]=9b8e5365-0b36-45f5-9c76-fbe439632367",
    "hydra:last": "/entity/2a15f539-3251-48e1-aaeb-a154dc9c6edb/resource?id[gt]=9b8e5365-0b36-45f5-9c76-fbe439632367"
  },
  "hydra:search": {
    "@type": "<string>",
    "hydra:template": "<string>",
    "hydra:variableRepresentation": "<string>",
    "hydra:mapping": [
      {
        "@type": "<string>",
        "variable": "<string>",
        "property": "<string>",
        "required": true
      }
    ]
  }
}

Authorizations

​
X-API-Key
string
header
required

Your API key is available in the Production and Sandbox dashboards.

Query Parameters

​
taxpayer.id
string

Filter by taxpayer ID (partial match)

Required string length: 12 - 13
Example:

"PEIC211118IS0"

​
taxpayer.name
string

Filter by taxpayer name (partial match)

Required string length: 1 - 254
Example:

"Pedro Infante Cruz"

​
taxpayer.personType
enum<string>

Filter by taxpayer type (exact match)

Available options:
physical,
legal
Example:

"physical"

​
taxpayer.registrationDate[before]
string<date-time>

Filter by taxpayer registration date (less than or equal <=)

​
taxpayer.registrationDate[strictly_before]
string<date-time>

Filter by taxpayer registration date (less than <)

​
taxpayer.registrationDate[after]
string<date-time>

Filter by taxpayer registration date (greater than or equal >=)

​
taxpayer.registrationDate[strictly_after]
string<date-time>

Filter by taxpayer registration date (greater than >)

​
createdAt[before]
string<date-time>

Filter by resource creation date (less than or equal <=)

​
createdAt[strictly_before]
string<date-time>

Filter by resource creation date (less than <)

​
createdAt[after]
string<date-time>

Filter by resource creation date (greater than or equal >=)

​
createdAt[strictly_after]
string<date-time>

Filter by resource creation date (greater than >)

​
updatedAt[before]
string<date-time>

Filter by the date the resource was last updated (less than or equal <=)

​
updatedAt[strictly_before]
string<date-time>

Filter by the date the resource was last updated (less than <)

​
updatedAt[after]
string<date-time>

Filter by the date the resource was last updated (greater than or equal >=)

​
updatedAt[strictly_after]
string<date-time>

Filter by the date the resource was last updated (greater than >)

​
order[createdAt]
enum<string>

Order by resource creation date

Available options:
asc,
desc
Example:

"asc"

​
order[updatedAt]
enum<string>

Order by resource update date

Available options:
asc,
desc
Example:

"asc"

​
id[lt]
string

The collection cursor pointer to the next page

​
id[gt]
string

The collection cursor pointer to the previous page

​
itemsPerPage
integer
default:20

The number of items per page

Required range: 1 <= x <= 1000

Response

Entity collection response

​
@context
string
default:/contexts/Entity
​
@id
string
default:/entities
​
@type
string
default:hydra:Collection
​
hydra:member
object[]
​
hydra:view
object

Pagination information

​
hydra:search
object