# Member object

## Fields

| Field                  | Type    | Description | Editable |
| ---------------------- | ------- | ----------- | -------- |
| last\_read\_at\_unix   | integer |             |          |
| unread\_message\_count | integer |             |          |
| is\_room\_visible      | boolean |             |          |
| user\_typing           | string  |             |          |

## Filters

| Field    | Description |
| -------- | ----------- |
| id       | ID          |
| room\_id | RoomのID     |
| user\_id | UserのID     |

[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/4a557e89a56ea430647b)

## find member

<mark style="color:blue;">`GET`</mark> `https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/{:id}`

#### Headers

| Name           | Type   | Description              |
| -------------- | ------ | ------------------------ |
| X-Access-Token | string | set you access token     |
| Content-Type   | string | application/vnd.api+json |
| Accept         | string | application/vnd.api+json |

{% tabs %}
{% tab title="200 " %}

```
HTTP/1.1 200 OK
Content-Type: application/vnd.api+json

{
  "data": {
    "id": "1",
    "type": "members",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1"
    },
    "attributes": {
      "last_read_at_unix": 1542602860,
      "unread_message_count": 1,
      "is_room_visible": true,
      "user_typing": null
    },
    "relationships": {
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      },
      "user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/user"
        },
        "data": {
          "type": "users",
          "id": "2"
        }
      }
    }
  }
}
```

{% endtab %}
{% endtabs %}

## search members

<mark style="color:blue;">`GET`</mark> `https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members`

#### Headers

| Name           | Type   | Description              |
| -------------- | ------ | ------------------------ |
| X-Access-Token | string | set you access token     |
| Content-Type   | string | application/vnd.api+json |
| Accept         | string | application/vnd.api+json |

{% tabs %}
{% tab title="200 " %}

```
{
  "data": [
    {
      "id": "1",
      "type": "members",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1"
      },
      "attributes": {
        "last_read_at_unix": 1542602860,
        "unread_message_count": 1,
        "is_room_visible": true,
        "user_typing": null
      },
      "relationships": {
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/room"
          },
          "data": {
            "type": "rooms",
            "id": "1"
          }
        },
        "user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/user"
          },
          "data": {
            "type": "users",
            "id": "2"
          }
        }
      }
    },
    {
      "id": "2",
      "type": "members",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/2"
      },
      "attributes": {
        "last_read_at_unix": 0,
        "unread_message_count": 0,
        "is_room_visible": false,
        "user_typing": null
      },
      "relationships": {
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/2/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/2/room"
          },
          "data": {
            "type": "rooms",
            "id": "3"
          }
        },
        "user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/2/relationships/user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/2/user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        }
      }
    },
    {
      "id": "3",
      "type": "members",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/3"
      },
      "attributes": {
        "last_read_at_unix": 0,
        "unread_message_count": 1,
        "is_room_visible": false,
        "user_typing": null
      },
      "relationships": {
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/3/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/3/room"
          },
          "data": {
            "type": "rooms",
            "id": "1"
          }
        },
        "user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/3/relationships/user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/3/user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        }
      }
    },
    {
      "id": "5",
      "type": "members",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/5"
      },
      "attributes": {
        "last_read_at_unix": 0,
        "unread_message_count": 0,
        "is_room_visible": false,
        "user_typing": null
      },
      "relationships": {
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/5/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/5/room"
          },
          "data": {
            "type": "rooms",
            "id": "5"
          }
        },
        "user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/5/relationships/user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/5/user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        }
      }
    },
    {
      "id": "6",
      "type": "members",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/6"
      },
      "attributes": {
        "last_read_at_unix": 0,
        "unread_message_count": 1,
        "is_room_visible": true,
        "user_typing": null
      },
      "relationships": {
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/6/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/6/room"
          },
          "data": {
            "type": "rooms",
            "id": "6"
          }
        },
        "user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/6/relationships/user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/6/user"
          },
          "data": {
            "type": "users",
            "id": "3"
          }
        }
      }
    },
    {
      "id": "7",
      "type": "members",
      "links": {
        "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/7"
      },
      "attributes": {
        "last_read_at_unix": 0,
        "unread_message_count": 0,
        "is_room_visible": false,
        "user_typing": null
      },
      "relationships": {
        "room": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/7/relationships/room",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/7/room"
          },
          "data": {
            "type": "rooms",
            "id": "6"
          }
        },
        "user": {
          "links": {
            "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/7/relationships/user",
            "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/7/user"
          },
          "data": {
            "type": "users",
            "id": "1"
          }
        }
      }
    }
  ],
  "meta": {
    "record_count": 6
  },
  "links": {
    "first": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members?page%5Bnumber%5D=1&page%5Bsize%5D=25",
    "last": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members?page%5Bnumber%5D=1&page%5Bsize%5D=25"
  }
}
```

{% endtab %}
{% endtabs %}

## create member

<mark style="color:green;">`POST`</mark> `https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members`

#### Headers

| Name           | Type   | Description              |
| -------------- | ------ | ------------------------ |
| Accept         | string | application/vnd.api+json |
| Content-Type   | string | application/vnd.api+json |
| X-Access-Token | string | set your access token    |

#### Request Body

| Name | Type   | Description |
| ---- | ------ | ----------- |
| data | object |             |

{% tabs %}
{% tab title="200 " %}

```
{
  "data": {
    "id": "8",
    "type": "members",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/8"
    },
    "attributes": {
      "last_read_at_unix": 0,
      "unread_message_count": 2,
      "is_room_visible": true,
      "user_typing": null
    },
    "relationships": {
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/8/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/8/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      },
      "user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/8/relationships/user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/8/user"
        },
        "data": {
          "type": "users",
          "id": "3"
        }
      }
    }
  }
}
```

{% endtab %}
{% endtabs %}

## update members

<mark style="color:orange;">`PUT`</mark> `https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/{:id}`

#### Headers

| Name           | Type   | Description              |
| -------------- | ------ | ------------------------ |
| X-Access-Token | string | set you access token     |
| Content-Type   | string | application/vnd.api+json |
| Accept         | string | application/vnd.api+json |

#### Request Body

| Name | Type   | Description |
| ---- | ------ | ----------- |
| data | object |             |

{% tabs %}
{% tab title="200 " %}

```
{
  "data": {
    "id": "1",
    "type": "members",
    "links": {
      "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1"
    },
    "attributes": {
      "last_read_at_unix": 1542602860,
      "unread_message_count": 1,
      "is_room_visible": true,
      "user_typing": null
    },
    "relationships": {
      "room": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/room",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/room"
        },
        "data": {
          "type": "rooms",
          "id": "1"
        }
      },
      "user": {
        "links": {
          "self": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/relationships/user",
          "related": "https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/1/user"
        },
        "data": {
          "type": "users",
          "id": "2"
        }
      }
    }
  }
}
```

{% endtab %}
{% endtabs %}

## delete member

<mark style="color:red;">`DELETE`</mark> `https://{YOUR_OKSKY_DOMAIN}/rapi/v1/members/{:id}`

#### Headers

| Name           | Type   | Description              |
| -------------- | ------ | ------------------------ |
| X-Access-Token | string | set you access token     |
| Content-Type   | string | application/vnd.api+json |
| Accept         | string | application/vnd.api+json |

{% tabs %}
{% tab title="204 " %}

```
Completed 204 No Content
```

{% endtab %}
{% endtabs %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ok-sky.com/resources-api/resources-object/member-object.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.