Passer au contenu principal
GET
cURL

Autorisations

Authorization
string
header
requis

Pour vos propres scripts et vos intégrations de serveur à serveur. Créez une clé dans l'application sous Paramètres > Accès > Clés d'API et copiez-la à ce moment-là, car elle n'est affichée qu'une fois. Envoyez-la sous la forme Authorization: Bearer <key>. La clé agit en tant que le membre qui l'a créée, dans l'organisation où elle a été créée. Un appel exige l'autorisation du membre et l'une des portées de la clé, comme inventory:read ou sales:write. Une clé avec * a toutes les portées.

Paramètres de requête

search
string | null

Texte à trouver dans l'UGS ou le nom, sans tenir compte de la casse. Jusqu'à 255 caractères.

Maximum string length: 255
type
enum<string> | null

Seulement les articles de ce type : stocked, non_stocked ou service. Omettez-le pour tous les types.

Options disponibles:
stocked,
non_stocked,
service
status
enum<string> | null

Quels articles inclure : active, archived ou all. active par défaut.

Options disponibles:
active,
archived,
all
after
string<uuid> | null

Le next_cursor de la page précédente. Omettez-le pour la première page.

fields[]
string[]

Valeurs de champs personnalisés que les articles doivent contenir, chacune sous la forme key:value, comme fields[]=material:Steel. Jusqu'à 10. Les champs confidentiels ne peuvent pas servir de filtre.

Pattern: ^[a-z][a-z0-9_]*:.+$

Réponse

ItemPageResource

data
ItemPageResource · object
requis

Une page d'articles, du plus récent au plus ancien.