STstreet
Companies

Get all Companies

Changed on

This endpoint retrieves multiple paginated companies along with meta and pagination information.

get/companies

Request

Query parameters

filter[trashed]'with' | 'only'

Optionally return result WITH deleted results or return ONLY deleted results.

includestring[]

Optional related entities to include in the results.

page[size]number
Example:25

Set the number of results per page.

page[number]number
Example:3

Set the page number.

filter[telephone_number]string

Filter results by the telephone number.

Response

OK.

Example response

{
  "data": [
    {
      "attributes": {
        "name": "Adams Builders",
        "address": {
          "single_line": "19 Lansdowne Road, Monton, Manchester",
          "anon_single_line": "Lansdowne Road, Monton, Manchester",
          "building_number": "19",
          "line_1": "19 Lansdowne Road",
          "line_2": "Monton",
          "line_3": "Manchester",
          "town": "Manchester",
          "country": "United Kingdom",
          "postcode": "M30 9PA",
          "udprn": "28327204",
          "geo": {
            "lat": 0.2365698,
            "lng": 53.023654
          }
        },
        "owner": {
          "title": "Mrs",
          "first_name": "Jane",
          "last_name": "Doe",
          "address": {
            "single_line": "19 Lansdowne Road, Monton, Manchester",
            "anon_single_line": "Lansdowne Road, Monton, Manchester",
            "building_number": "19",
            "line_1": "19 Lansdowne Road",
            "line_2": "Monton",
            "line_3": "Manchester",
            "town": "Manchester",
            "country": "United Kingdom",
            "postcode": "M30 9PA",
            "udprn": "28327204",
            "geo": {
              "lat": 0.2365698,
              "lng": 53.023654
            }
          },
          "telephone_numbers": [
            {
              "value": "+441632960911"
            }
          ],
          "email_addresses": [
            {
              "value": "john@johndoe.com"
            }
          ]
        }
      },
      "relationships": {
        "properties": {
          "data": [
            {
              "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
            }
          ]
        },
        "applicants": {
          "data": [
            {
              "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
            }
          ]
        },
        "people": {
          "data": [
            {
              "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "attributes": {
        "address": {
          "single_line": "19 Lansdowne Road, Monton, Manchester",
          "anon_single_line": "Lansdowne Road, Monton, Manchester",
          "building_number": "19",
          "line_1": "19 Lansdowne Road",
          "line_2": "Monton",
          "line_3": "Manchester",
          "town": "Manchester",
          "country": "United Kingdom",
          "postcode": "M30 9PA",
          "udprn": "28327204",
          "geo": {
            "lat": 0.2365698,
            "lng": 53.023654
          }
        },
        "material_information": {
          "council_tax_band": "D"
        }
      },
      "relationships": {
        "branch": {
          "data": {
            "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
          }
        }
      }
    }
  ],
  "links": {
    "self": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=2",
    "first": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=1",
    "next": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=1",
    "prev": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=3",
    "last": "http://localhost:3000/users?page[number]=2&page[size]=25&page[number]=9"
  },
  "meta": {
    "pagination": {
      "total": 226,
      "count": 10,
      "per_page": 10,
      "current_page": 1,
      "total_pages": 23
    }
  }
}

Changes

  • b01c2825aba9Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ////// to the response with the status

    • info

      added the optional property ////// to the response with the status

  • 6ed52b1e6e1eRevision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status