๐ŸญGet All Businesses

Retrieve all the Business records on your unique Gathr database.

Get All Businesses

GET {{baseUrl}}/businesses

Retrieve all of the business records available on your tenant_id.

Path Parameters

NameTypeDescription

tenantId*

String

This is the tenantId that was assigned to you when your tenant was created. You will have received this information via message from a member of the Finch Technologies team. If you can't find it, please email support@finch-technologies.com.

environmentUrl*

String

https://uat.apply.fincheck.co.za

This is the environment URL for uat. Once you change over to prod, you would have to use: https://apply.fincheck.co.za.

*Please note that you need to be set up in each environment by a member of the Finch Technologies team, who will share your bearer token with you for the specific environment in a protected link.

```json
{
    "data": [
        {
            "id": "{{businessId}}",
            "name": "Finch Technologies (Pty) Ltd",
            "type": "Private Company",
            "reg": "2015/123456/23",
            "enterprise_num": "K2016513771",
            "linked_customers": [],
            "cipc_business_verified": false,
            "cipc_director_verified": false,
            "cipc_information": null,
            "cipc_timestamp": null
        },
        {
            "id": "{{businessId}}",
            "name": "Kirsten Candy",
            "type": "Sole Proprietor",
            "reg": "xxx /123456/xx",
            "enterprise_num": "K201651xxxx",
            "linked_customers": [],
            "cipc_business_verified": false,
            "cipc_director_verified": false,
            "cipc_information": null,
            "cipc_timestamp": null
        }
    ],
    "links": {
        "first": "http://dev.apply.fincheck.co.za/gathrdocs/api/v1/businesses?page=1",
        "last": "http://dev.apply.fincheck.co.za/gathrdocs/api/v1/businesses?page=1",
        "prev": null,
        "next": null
    },
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://dev.apply.fincheck.co.za/gathrdocs/api/v1/businesses?page=1",
                "label": "1",
                "active": true
            },
            {
                "url": null,
                "label": "Next »",
                "active": false
            }
        ],
        "path": "http://dev.apply.fincheck.co.za/gathrdocs/api/v1/businesses",
        "per_page": 15,
        "to": 2,
        "total": 2
    }
}
```

Last updated