HQ Rental Software

Show a list of all contact categories

GET/contacts/categories

Lists all contact categories created in the system

Request

Query Params

limit

integer

optional

The amount of results per page.

Example:

page

integer

optional

The page of results to view.

Example:

Responses

OK(200)

Parameter Error(422)

Server Error(500)

HTTP Code: 200

Content Type : JSONapplication/json

successful operation

object {0}

{
  "current_page": 1,
  "data": [
    {
      "id": 4,
      "label": "Companies",
      "icon": "fas fa-building",
      "entity": "company",
      "filters": null,
      "archived": false,
      "total_contacts": 0,
      "order": 0,
      "created_by": 12,
      "updated_by": 12,
      "deleted_at": null,
      "created_at": "2020-07-02T13:57:35.000000Z",
      "updated_at": "2020-07-02T13:57:35.000000Z",
      "uuid": "c082125f-b17a-41a2-b522-d700b76d41e3",
      "enable_mailchimp_sync": false,
      "target_mailchimp_lists": null,
      "contact_entity_field_id": null,
      "show_view_section_with_all_fields": false,
      "field_sections_for_quick_create": [],
      "scannr_fields": null,
      "translated_label": {
        "en": "",
        "es": "",
        "pt": ""
      },
      "allowed_for_public_view": false,
      "allowed_for_public_edit": false,
      "custom_header": null,
      "custom_code_after_body_tag": null,
      "hidden_sections_for_public": null,
      "preview_message": null,
      "success_message": null,
      "requires_manual_verification": false
    },
    {
      "id": 3,
      "label": "Customers",
      "icon": "users",
      "entity": "person",
      "filters": null,
      "archived": false,
      "total_contacts": 0,
      "order": 0,
      "created_by": 1,
      "updated_by": 67,
      "deleted_at": null,
      "created_at": "2015-11-02T05:16:00.000000Z",
      "updated_at": "2018-10-16T13:21:27.000000Z",
      "uuid": "af0ddd63-2b86-42d7-86bc-98e90a717575",
      "enable_mailchimp_sync": false,
      "target_mailchimp_lists": null,
      "contact_entity_field_id": null,
      "show_view_section_with_all_fields": false,
      "field_sections_for_quick_create": null,
      "scannr_fields": "{\"scannr_sex\": \"2\", \"scannr_address\": \"\", \"scannr_birthday\": \"15\", \"scannr_address_city\": \"195\", \"scannr_address_street\": \"193\", \"scannr_identification\": \"18\", \"scannr_customer_full_name\": \"2\", \"scannr_customer_id_number\": \"\", \"scannr_customer_first_name\": \"2\", \"scannr_document_issue_date\": \"18\", \"scannr_customer_family_name\": \"3\", \"scannr_document_expiration_date\": \"18\"}",
      "translated_label": null,
      "allowed_for_public_view": false,
      "allowed_for_public_edit": false,
      "custom_header": null,
      "custom_code_after_body_tag": null,
      "hidden_sections_for_public": null,
      "preview_message": null,
      "success_message": null,
      "requires_manual_verification": false
    }
  ],
  "first_page_url": "",
  "from": 1,
  "last_page": 1,
  "last_page_url": "",
  "next_page_url": null,
  "path": "",
  "per_page": 15,
  "prev_page_url": null,
  "to": 2,
  "total": 2
}

Last modified: 22 days ago