GET /api/account/contact-groups

get/api/account/contact-groups

Beispielanfrage

GET https://api.jupiter-erp.com/api/account/contact-groups

Code

curl -X GET 'https://api.jupiter-erp.com/api/account/contact-groups' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'X-Account-Uuid: YOUR_ACCOUNT_UUID' \
  -H 'Accept: application/json'

Parameter

Name	In	Pflicht	Beschreibung
name	query	nein	Search by name. Supports SQL-like syntax: - `test`: begins with `test` - `test`: ends with `test` - `test`: contains `test` - `test`: exact match.
ids[]	query	nein	—
order_by	query	nein	Sort by a specific field
#/components/parameters/OrderDirParameter
#/components/parameters/PerPageParameter
#/components/parameters/PageParameter

Antworten

200OK

ModellListContactGroups200Response

Feld

Typ

Beschreibung

data*

object[]

array

Elemente

Feld	Typ	Beschreibung
contacts_count*	integer	Amount of contacts assigned to this group
id*	integer	Unique identifier for the group.
name*	string	Name of the group.

meta*

object

Feld	Typ	Beschreibung
current_page*	integer	The current page number.
items_from*	integer	The starting item number on the current page.
items_to*	integer	The ending item number on the current page.
last_page*	integer	The last page number.
per_page*	integer	The number of items per page.
total*	integer	The total number of items.

Beispiel Response

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "contacts_count": 0
    }
  ],
  "meta": {
    "current_page": 1,
    "last_page": 1,
    "per_page": 15,
    "total": 1,
    "items_from": 1,
    "items_to": 1
  }
}

ContactGroups

Fragen zur Integration?