User

Create a new user

POST /users

This API endpoint is used to create a new user within a system. The user creation process requires proper authorization and an organization ID for context. The API generates a unique user identifier upon successful creation.

Body

Name	Type	Description
external_reference	string	External reference identifier for the user

Response

201

{
  "status": "success",
  "user_id": string,  // Unique identifier for the user generated by Community Incentives
  "date_created": string  // ISO 8601 format
}

409

422

Look Up User ID by External Reference

GET /users?external_reference={external_reference}

This API is used to retrieve user id based on an external reference identifier.

Query Parameters

Name	Type	Description
external_reference	string	external reference identifier for the user

Body

The request body should be empty

Response

200

{
  "status": "success",
  "user_id": string,  // Unique identifier for the user generated by Community Incentives
  "external_reference": string,  // External reference identifier for the user
  "date_created": string  // ISO 8601 format
}

422

404

Look Up User by ID

GET /users/{user_id}

This API is used to retrieve user information based on user ID.

Body

The request body should be empty

Response

200

{
  "status": "success",
  "user_id": string,  // Unique identifier for the user generated by Community Incentives
  "external_reference": string,  // External reference identifier for the user
  "date_created": string  // ISO 8601 format
}

422

Update User by ID

PUT /users/{user_id}

This API is used to update user external_reference based on user ID.

Body

Name	Type	Description
external_reference	string	External reference identifier for the user

Response

200

{
    "status": "success",
    "user_id": string, // Unique identifier for the user generated by Community Incentives
    "date_created": string  // ISO 8601 format
}

409

422