Read All

GET /api/congregations

Fetch all congregations

Query parameters

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object
      • name string Required

        Minimum length is 2, maximum length is 100.

      • number integer | null

        Minimum value is 1.0.

      • city string Required

        Minimum length is 2, maximum length is 100.

      • state string | null Required

        Minimum length is 2, maximum length is 50.

      • id string Required

        Maximum length is 26.

      • circuit object | null
        Hide circuit attributes Show circuit attributes object | null
        • name string Required

          Minimum length is 3, maximum length is 100.

        • id string Required

          Maximum length is 26.

    • total integer Required
    • page integer Required
    • perPage integer Required
    • totalPages integer Required
    • hasNextPage boolean Required
  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
GET /api/congregations
curl \
 -X GET https://metropolitanacolombia.org/api/congregations \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "items": [
    {
      "name": "string",
      "number": 42,
      "city": "string",
      "state": "string",
      "id": "string",
      "circuit": {
        "name": "string",
        "id": "string"
      }
    }
  ],
  "total": 42,
  "page": 42,
  "perPage": 42,
  "totalPages": 42,
  "hasNextPage": true
}
Response examples (422)
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}