Business Guides

Return all guides that mentions the business.

Parameters

  • idpath integerRequired

    Return all guides that mentions the business by the specific business id. You can retrieve this id from ...

  • includequery string

    Include associations (delimited with comma). Available associations: user.

  • sortquery string

    Sort ascending or descending order.

  • pagequery integer

    Page offset to fetch.

  • per_pagequery integer

    Number of results to return per page.

GET/api/v1/businesses/{id}/guides

{
  const res = await fetch(`${BASE_URL}/api/v1/businesses/${id}/guides`, {
    method: 'GET',
    headers: {
      'Content-Type': 'application/json'
    }});
  const data = await res.json();
}

RESPONSE

{
  "data": [
    {
      "id": "a72ae1a8-747f-4705-a6a9-404e3194f024",
      "type": "guides",
      "links": {
        "self": "/guides/a72ae1a8-747f-4705-a6a9-404e3194f024"
      },
      "attributes": {
        "author-name": "QA Detective",
        "created-at": "2022-04-20T09:29:05.741Z",
        "description": "Hi, this is a test guide",
        "detected-language": "la",
        "main-photo": {
          "url": "https://foodetective-staging-backend-data.s3.amazonaws.com/uploads/guide/main_photo/a72ae1a8-747f-4705-a6a9-404e3194f024/8d05f23a-1b67-483f-ad24-f270b1e514d3.jpeg",
          "desktop": {
            "url": "https://foodetective-staging-backend-data.s3.amazonaws.com/uploads/guide/main_photo/a72ae1a8-747f-4705-a6a9-404e3194f024/desktop_8d05f23a-1b67-483f-ad24-f270b1e514d3.jpeg"
          },
          "tablet": {
            "url": "https://foodetective-staging-backend-data.s3.amazonaws.com/uploads/guide/main_photo/a72ae1a8-747f-4705-a6a9-404e3194f024/tablet_8d05f23a-1b67-483f-ad24-f270b1e514d3.jpeg"
          }
        },
        "name": "Test Guide",
        "slug": "test-guide-dd3add1e-a142-4dda-94f4-46da7d912a08"
      },
      "relationships": {
        "user": {
          "links": {
            "self": "/guides/a72ae1a8-747f-4705-a6a9-404e3194f024/relationships/user",
            "related": "/guides/a72ae1a8-747f-4705-a6a9-404e3194f024/user"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 1,
    "total-pages": 1
  }
}