Lista os reconhecimentos de um espaço de Reconhecimento
GET/api/recognitions
- Auth
- Requiere token
- Clave de API:
- No acepta clave de API
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
Qualquer papel, desde que abra o espaço de Reconhecimento (as mesmas regras de acesso do espaço: visibilidade, grupos, produtos, planos). A comunidade pode ter vários espaços de Reconhecimento: `spaceId` traz o mural de um deles; sem `spaceId`, vêm juntos os de todos os espaços que a pessoa abre. Mais novos primeiro. `memberId` filtra o que uma pessoa deu ou recebeu. Sem espaço de Reconhecimento (ou `spaceId` que não é um): 404; espaço fechado para quem pede (ou nenhum aberto): 403.
Parámetros
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
pageopcional | query | integer | |
limitopcional | query | integer | |
memberIdopcional | query | string (uuid) | |
spaceIdopcional | query | string (uuid) | Um espaço de Reconhecimento; sem ele, todos os que a pessoa abre. |
valueIdopcional | query | string | Só os reconhecimentos de um valor da comunidade (uuid) ou `none` (os sem valor). |
typeopcional | query | APPRECIATION | WELCOME | MILESTONE | AWARD | EVENT | GRADUATION | WORK_ANNIVERSARY | Só os de um tipo (inexistente: 400). |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
X-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Respuestas
| Código | Descripción |
|---|---|
200 | Reconhecimentos e paginação. |
400 | `type` inexistente (`typeInvalid`). |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | Autenticado, mas sem permissão para esta operação. |
404 | Recurso não encontrado. |
500 | Erro interno do servidor. |
Ejemplo con curl
curl -X GET "https://api.memberfy.net/api/recognitions" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID"