Get a member's public profile

GET

/directories/{id}

const url = 'https://acme.mykreezalid.com/front_api/v1/directories/4242';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://acme.mykreezalid.com/front_api/v1/directories/4242

Returns the public profile of a member: name, picture, member group and store presentation. Works without an access token.

Parameters

Path Parameters

required

integer

Example

Identifier of the member.

Responses

200

The member’s public profile.

application/json

object

user

object

object

string

integer

public_name

string

avatar

URL of the member’s profile picture.

string format: uri

nullable

group

The member group the member belongs to.

object

object

string

integer

nullable

name

string

nullable

alias

string

nullable

store

Presentation of the member’s store. Both fields are null when the member has no store.

object

description

string

nullable

cover

Cover image of the store.

string

nullable

Example

{
  "user": {
    "object": "User",
    "id": 4242,
    "public_name": "Jane D.",
    "group": {
      "object": "Group",
      "id": 12,
      "name": "Vendors",
      "alias": "vendors"
    }
  }
}

404

No member has this identifier.

application/json

Error body returned by the Front API when it refuses a request.

object

code

HTTP status code, repeated in the body.

integer

status

string

message

Human-readable reason.

string

Example

{
  "code": 403,
  "status": "error",
  "message": "Token not found in request"
}